6.1 创建外部用户群组
基本信息
Path: /api/v1/externalUserBand/create
Method: POST
接口描述:
- 创建一个外部用户群组
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
- 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
- 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户管理”页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string[] | 必须 | 群组名列表,该接口允许批量创建群组 | ||
userDirectoryId | string | 与userDirectoryName二选一 | 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准 | ||
userDirectoryName | string | 与userDirectoryId二选一 | 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准 | ||
description | string | 非必须 | 描述 | ||
userIdList | string[] | 非必须 | 用户ID列表,ID和名称只需传一个即可,都传时以ID为准 | ||
userNameList | string[] | 非必须 | 用户名称列表,ID和名称只需传一个即可,都传时以ID为准 |
请求示例
{
"userDirectoryId": "30fe65e0-ee13-11eb-8358-05ceb6b852d7",
"name": [
"band2"
],
"description": "band2-desc",
"userNameList": [
"张三",
"李四"
]
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | string[] | 必须 | 角色ID | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data":["574229e0-d19c-11ec-b981-25f35dfc3047"],
"msg": "请求成功",
"traceId": "0321d1efe3801000"
}
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |
用户目录不存在 | 77200004 |
群组名称(%s)已存在 | 77200005 |
部分用户数据已经删除,请重新选择 | 10000001 |
服务器内部错误 | 10000000 |